Open
Conversation
Open
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation Restructure and Expansion
This PR introduces a substantial reorganisation and expansion of the PhEval documentation. The update improves conceptual clarity, navigation, and contributor guidance, while aligning the documentation structure more closely with PhEval’s architecture and plugin ecosystem.
Structural Reorganisation
The documentation has been restructured into clearly defined, purpose-driven sections:
This structure improves discoverability for new users while making advanced topics more accessible for experienced contributors.
Expanded Developer Documentation
Significant enhancements have been made to support contributors and plugin developers:
These changes reinforce PhEval’s role as an extensible benchmarking framework.
Utility Documentation Enhancements
Dedicated documentation has been added for key utilities that were previously under-documented:
This ensures supporting functionality is clearly described and reproducible.
New and Expanded Content
These additions help bridge the gap between conceptual understanding and operational use.
Documentation Cleanup
Visual and Navigation Improvements